Add the Thrift tutorial #4865

haneepark · 2023-05-08T08:08:44Z

Motivation:

Provide a tutorial for beginners who wants to use Apache Thrift with Armeria

Modifications:

Add a tutorial for writing an Apache Thrift service with Armeria

Result:

Adds the tutorial in the "THRIFT SERVICE" menu in armeria.dev site.

Please note:

This PR is a draft, since I need to address some questions before requesting the review. Please take a look at the comments starts with // TW: in index.mdx.

Add thrift tutorial images Update site/src/pages/tutorials/thrift/blog/create-server.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/create-server.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/create-server.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-create.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-create.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-update.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-create.mdx Co-authored-by: Hanee Park <[email protected]> Update implement-create.mdx Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-read.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-read.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-read.mdx Co-authored-by: Hanee Park <[email protected]> Update site/src/pages/tutorials/thrift/blog/implement-read.mdx Co-authored-by: Hanee Park <[email protected]> Update index.mdx Update site/src/pages/tutorials/thrift/blog/run-service.mdx Co-authored-by: Hanee Park <[email protected]> Update index.mdx Update run-service.mdx Update create-server.mdx Update run-service.mdx Rename run-service.mdx to create-client.mdx Update toc.json Update create-server.mdx Update implement-read.mdx Update implement-read.mdx Update implement-read.mdx Update implement-update.mdx Update implement-delete.mdx Update add-docservice.mdx Update create-server.mdx Update implement-create.mdx

CLAassistant · 2023-05-08T08:08:51Z

All committers have signed the CLA.

jrhee17 · 2023-05-08T08:10:42Z

Looking forward to this PR!

This PR is a draft, since I need to address some questions before requesting the review. Please take a look at the comments starts with // TW: in index.mdx.

Will do 🙇

site/src/pages/tutorials/thrift/blog/index.mdx

jrhee17

Looking good! Let me know when this PR is ready for review 🙇

site/src/pages/tutorials/thrift/blog/index.mdx

site/src/pages/tutorials/thrift/blog/implement-delete.mdx

Co-authored-by: jrhee17 <[email protected]>

haneepark · 2023-05-16T01:37:36Z

@jrhee17 @ikhoon @trustin @minwoox
The PR is ready for your review (_ _)

…ient line#4865 (comment)

haneepark · 2023-06-02T06:30:50Z

Perhaps I should have asked this earlier, but I'm wondering if there is a style guide or coding convention I can refer to when working on the Armeria project.

To be more specific,

I wonder if there is a maximum character limit for a single line. (Add the Thrift tutorial #4865 (comment))
I'm a bit confused about the indent rule for the method chaining, and I'm concerned that I might be inconsistent.

jrhee17 · 2023-06-05T06:35:06Z

Sorry about the confusion, I don't think there are a set of rules that we strictly follow 😅

I wonder if there is a maximum character limit for a single line.

In this project I think we have a rule for max 112 characters per line for java files

armeria/settings/checkstyle/checkstyle.xml

Line 27 in 4c9dccf

.
This isn't enforced for other file types, but I guess this is a good rule to follow.

I'm a bit confused about the indent rule for the method chaining, and I'm concerned that I might be inconsistent.

I think the general rule is as long as the code block doesn't overflow we should be good.
For now, what do you think of sticking to always 2 space indentations?

I apologize since I think this comment may have caused confusion (actually I think I wasn't sure myself 😅 )

jrhee17

Only nits, but nothing too serious. Still looks good to me 👍

@minwoox @ikhoon I think this PR is ready for review 😄

site/src/pages/tutorials/thrift/blog/index.mdx

site/src/pages/tutorials/thrift/blog/run-server.mdx

examples/tutorials/thrift/src/main/java/example/armeria/server/blog/thrift/BlogClient.java

site/src/pages/tutorials/thrift/blog/implement-read.mdx

site/src/pages/tutorials/thrift/blog/implement-update.mdx

site/src/pages/tutorials/thrift/blog/implement-delete.mdx

Co-authored-by: jrhee17 <[email protected]>

line#4865 (comment)

Co-authored-by: jrhee17 <[email protected]>

jrhee17 · 2023-06-14T06:40:43Z

Reviews are a little slow at the moment since we're busy releasing the next version 😅 Sorry about it.
Will try to ping other reviewers once release is done (probably this week)

trustin

Way to go, @haneepark! 🚀🙇

ikhoon

Thanks a lot, @haneepark! ❤️🚀 This is a well-written tutorial!

minwoox

Thanks for writing this awesome tutorial, @haneepark! 👍 🙇 🙇‍♂️

Motivation: - There are differences among Armeria tutorials: structural difference in introduction, style differences in writing. - Different ways(curl, logging, testing) are used to verify its implementation in each tutorial. - The Thrift tutorial is most recently updated (#4865) and using test code seems to be the most appropriate way to go. Modifications: - Update introductions for each tutorials - Update REST tutorial to use test code - Rewrite gRPC tutorial to align with Thrift tutorial Result: - Updates tutorials on Armeria site --------- Co-authored-by: jrhee17 <[email protected]>

geun-son and others added 13 commits May 8, 2023 10:48

Rewrite Thrift tutorial introduction

2c86fdf

Update toc for Thrift tutorial

5765946

Rewrite implement CREATE for Thrift tutorial

9902dde

Rewrite implement READ for Thrift tutorial

60f94a5

Rewrite implement UPDATE for Thrift tutorial

a744e63

Rewrite implement DELETE for Thrift tutorial

00f31af

Add define service method step in Thrift tutorial

358f2d6

Add DocService in implement DELETE step

41e9c09

Change expressions in Thrift tutorial

f4a1085

Update what you need for Thrift tutorial

d6ef691

Write intros and outros for each steps in Thrift tutorial

eb4355a

Update expressions and sentences in Thrift tutorial

da0956e

jrhee17 added the documentation label May 8, 2023

jrhee17 added this to the 1.24.0 milestone May 8, 2023

Merge branch 'main' of github.com:line/armeria into thrift-tutorial

1d68d46

jrhee17 reviewed May 9, 2023

View reviewed changes

site/src/pages/tutorials/thrift/blog/index.mdx Outdated Show resolved Hide resolved

site/src/pages/tutorials/thrift/blog/index.mdx Outdated Show resolved Hide resolved

site/src/pages/tutorials/thrift/blog/implement-delete.mdx Outdated Show resolved Hide resolved

haneepark and others added 8 commits May 11, 2023 14:09

Update introduction for Thrift tutorial

531034d

Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx

f95c091

Co-authored-by: jrhee17 <[email protected]>

Add BlogClient for testing Thrift tutorial

efc9544

Add more test cases for Thrift tutorial

b46fd02

Use BlogServiceTest instead of using separate client module

33d928f

Remove class declarations in code snippets if possible

c10796c

Fix a typo

dece866

Update expressions in Thrift Tutorial

b1f1720

haneepark marked this pull request as ready for review May 16, 2023 01:37

Introduce testing in the earlier step and remove main() method for cl…

8e1ec88

…ient line#4865 (comment)

jrhee17 approved these changes Jun 5, 2023

View reviewed changes

haneepark and others added 13 commits June 7, 2023 10:57

Update site/src/pages/tutorials/thrift/blog/index.mdx

c342cea

Co-authored-by: jrhee17 <[email protected]>

Mention directory path explicitly

4e50577

line#4865 (comment)

Update site/src/pages/tutorials/thrift/blog/run-server.mdx

d584c0f

Co-authored-by: jrhee17 <[email protected]>

Update site/src/pages/tutorials/thrift/blog/run-server.mdx

3da77f9

Co-authored-by: jrhee17 <[email protected]>

Remove the main method in BlogClient

8511376

Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx

21d357e

Co-authored-by: jrhee17 <[email protected]>

Update site/src/pages/tutorials/thrift/blog/implement-delete.mdx

a03a006

Co-authored-by: jrhee17 <[email protected]>

Update site/src/pages/tutorials/thrift/blog/implement-update.mdx

fe780c0

Co-authored-by: jrhee17 <[email protected]>

Update site/src/pages/tutorials/thrift/blog/implement-read.mdx

98ca732

Co-authored-by: jrhee17 <[email protected]>

Update site/src/pages/tutorials/thrift/blog/implement-read.mdx

7b60018

Co-authored-by: jrhee17 <[email protected]>

Update site/src/pages/tutorials/thrift/blog/implement-create.mdx

dea93a3

Co-authored-by: jrhee17 <[email protected]>

Remove or disable the hello() test method

c4358d1

Make the implementing READ step simpler and clearer

f3c13b7

jrhee17 modified the milestones: 1.24.0, 1.25.0 Jun 9, 2023

trustin approved these changes Jun 14, 2023

View reviewed changes

Use cpp as syntax highlighter since there is no highlighter for thrift

1173e70

ikhoon approved these changes Jun 20, 2023

View reviewed changes

minwoox approved these changes Jun 21, 2023

View reviewed changes

ikhoon modified the milestones: 1.25.0, 1.24.1 Jun 21, 2023

ikhoon merged commit a575329 into line:main Jun 21, 2023

haneepark deleted the thrift-tutorial branch January 11, 2024 02:15

haneepark mentioned this pull request Feb 6, 2024

Update REST and gRPC tutorials to use test code #5445

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the Thrift tutorial #4865

Add the Thrift tutorial #4865

haneepark commented May 8, 2023

CLAassistant commented May 8, 2023 •

edited

Loading

jrhee17 commented May 8, 2023

jrhee17 left a comment •

edited

Loading

haneepark commented May 16, 2023

haneepark commented Jun 2, 2023 •

edited

Loading

jrhee17 commented Jun 5, 2023 •

edited

Loading

jrhee17 left a comment

jrhee17 commented Jun 14, 2023

trustin left a comment

ikhoon left a comment

minwoox left a comment

Add the Thrift tutorial #4865

Add the Thrift tutorial #4865

Conversation

haneepark commented May 8, 2023

CLAassistant commented May 8, 2023 • edited Loading

jrhee17 commented May 8, 2023

jrhee17 left a comment • edited Loading

Choose a reason for hiding this comment

haneepark commented May 16, 2023

haneepark commented Jun 2, 2023 • edited Loading

jrhee17 commented Jun 5, 2023 • edited Loading

jrhee17 left a comment

Choose a reason for hiding this comment

jrhee17 commented Jun 14, 2023

trustin left a comment

Choose a reason for hiding this comment

ikhoon left a comment

Choose a reason for hiding this comment

minwoox left a comment

Choose a reason for hiding this comment

CLAassistant commented May 8, 2023 •

edited

Loading

jrhee17 left a comment •

edited

Loading

haneepark commented Jun 2, 2023 •

edited

Loading

jrhee17 commented Jun 5, 2023 •

edited

Loading